Apparatus and method for automating the logging of table changes in a database

ABSTRACT

A system and method for logging changes to a database table are disclosed. The system comprises an administration tool, table metadata, a history table, and a service engine. The administration tool provides an interface through which a DBA, database programmer, or other user can manage the table metadata and the history table, including the selection of columns within the table for which the system will track changes. In the preferred embodiment, the service engine is a middleware application that tracks changes for the selected columns. The service engine processes all user-requested database operations and adds operations to manage the history table before relaying the request operations to a DBMS. Alternatively or additionally, the service engine may be a wrapper to existing services that the database application provides.

FIELD OF THE INVENTION

The field of the invention is data processing in general, and specifically database processing that generates a record of changes to database tables.

BACKGROUND OF THE INVENTION

In general, a database is any collection of information organized for rapid search and retrieval. A database stored in a computer-readable medium commonly is modeled as a collection of one or more tables. Each table, in turn, is modeled as a collection of one or more records (referred to commonly as a “row”), and each record as a collection of one or more fields (referred to commonly as a “column”).

Generally, three types of users interact with a database: database administrators (DBAs), database programmers, and end-users. Each type of user interacts with a database through database management systems (DBMS), which are sophisticated server programs that directly manipulate data within a database. Most modern DBMSs support a standard structured query language (SQL), through which a user can specify exactly what information a database should store or retrieve for the user.

A DBA is responsible primarily for managing the information in a database. A DBA determines what goes into the database, how the database is structured and how information in the database is accessed. A DBA also determines how the database is secured and how the integrity of the database is checked and maintained. The DBA also monitors the database performance.

In contrast, a database programmer is primarily responsible for creating computer programs through which end-users can manipulate and apply to the data in a database to accomplish a specific task. Such programs (referred to herein as “database applications”) interact with a database through a DBMS within the constraints that the DBA has established. Database applications often use SQL or some minor variation adapted for use in such programs.

For many years, database programmers have developed “client” database applications that interact directly with a DBMS server. In general, these database applications provide a user interface to the DBMS and implement an enterprise's business rules for a particular application, such as entering a customer's order for products. The enterprise data, though, remained relatively centralized and available to multiple clients through the DBMS. In recent years, this traditional “two-tier” client/server system has been displaced slowly by more sophisticated multi-tier client/server systems. In general, a multi-tier system places at least one intermediate component between the client and the server. These components are referred to commonly as “middleware.” Programmers often use multiple client/server tiers to separate and delegate particular programming tasks. In particular, one tier usually provides a user interface, while a second tier implements an enterprise's business rules. A third tier generally implements the underlying data processing (such as creating a data structure to represent a customer's order in a database).

Regardless of architecture, though, most database applications frequently insert, modify, or delete data in the tables of a database. A history of these actions is often useful to administrators, auditors, and other analysts within an enterprise. Thus, many database applications record such actions in a log. A log may take many forms, but the most common include a separate table within the database itself and simple text files stored in the file systems somewhere. Although distinct database applications may share a single log, each database application generally is responsible for implanting a process for recording its own changes in the log. Consequently, each database programmer must write code that processes and records table changes in a log.

Of course, not only is it useful to record the history of changes to a database, but it is also sometimes useful to record the user that caused the changes and the time at which the changes occurred. In order to identify the user and time, database applications usually insert the user name and timestamp into each action.

The practical applications for change logs abound, as exemplified in U.S. Pat. No. 6,321,236 (the '236 patent). The '236 patent discloses a technique for storing table differences that are used to make client copies of a particular database table current. A client receives a client copy of a table having a version identifier. Later, the client requests synchronization of the client copy with the original database table on the server. The version identifier of the client copy of the database engine is accessed and all intervening updates are translated into instructions that are understood by the type of database engine run on the client system.

United States Patent U.S. Pat. No. 6,631,374 (the '374 patent) also discloses a system in which changes to a database are important. Specifically, the '374 patent discloses a system and method for temporarily accessing data values in a database as of a requested query time. Whenever a transaction makes a change to a relative database block, the database engine creates an interested transaction entry, which is stored in the relative database block. A record of database operations is kept that includes transactions effecting row data changes.

Finally, United States application 2003/0212647 (the '647 application) discloses a method and system for maintaining a change history for a database design. More particularly, the '647 application allows change history data corresponding to a database design change to be automatically transmitted to the changed database.

While the concept of database change logs is not new, there currently is no convenient mechanism for centrally recording and managing such information. As already noted, database programmers must implement change log management in every conventional database application in which such information is desired. Clearly, any system that could eliminate this redundant and time consuming programming effort would have an immediate impact on development and administration costs, and contribute significantly to the advancement of this technical field. Those skilled in this art should appreciate the utility of the following detailed description of a novel system that addresses this need.

SUMMARY OF THE INVENTION

The invention that meets the needs identified above is a system and method for logging changes to a database table. The system comprises an administration tool, table metadata, a history table, and a service engine. The administration tool provides an interface through which a DBA, database programmer, or other user can manage the table metadata and the history table, including the selection of columns within the table for which the system will track changes. In the preferred embodiment, the service engine is a middleware application that tracks changes for the selected columns. The service engine processes all user-requested database operations and adds operations to manage the history table before relaying the request operations to a DBMS. Alternatively, the service engine may be a wrapper to existing services that the database application provides.

BRIEF DESCRIPTION OF DRAWINGS

The novel features believed characteristic of the invention are set forth in the appended claims. The invention itself, however, as well as a preferred mode of use, further objectives and advantages thereof, will be understood best by reference to the following detailed description of an illustrative embodiment when read in conjunction with the accompanying drawings, wherein:

FIG. 1 illustrates an architecture for connecting various hardware devices to create a network for transferring data;

FIG. 2 is a diagram illustrating one embodiment of the internal configuration of a computer;

FIG. 3 is a flow chart of the logic of the Administration Tool; and

FIG. 4 is a flow chart of the logic of the Service Engine (SE).

DETAILED DESCRIPTION OF THE PREFERRED EMBODIMENT

The principles of the present invention are applicable to a variety of computer hardware and software configurations. The term “computer hardware” or “hardware,” as used herein, refers to any machine or apparatus that is capable of accepting, performing logic operations on, storing, or displaying data, and includes without limitation processors and memory; the term “computer software” or “software,” refers to any set of instructions operable to cause computer hardware to perform an operation. A “computer,” as that term is used herein, includes without limitation any useful combination of hardware and software, and a “computer program” or “program” includes without limitation any software operable to cause computer hardware to accept, perform logic operations on, store, or display data. A computer program may, and often is, comprised of a plurality of smaller programming units, including without limitation subroutines, modules, functions, methods, and procedures. Thus, the functions of the present invention may be distributed among a plurality of computers and computer programs.

Additionally, the invention is described below with reference to an exemplary network of hardware devices, as depicted in FIG. 1. A “network” comprises any number of hardware devices coupled to and in communication with each other through a communications medium, such as the Internet. A “communications medium” includes without limitation any physical, optical, electromagnetic, or other medium through which hardware or software can transmit data. For descriptive purposes, exemplary network 100 has only a limited number of nodes, including workstation computer 105, workstation computer 110, server computer 115, and persistent storage 120. Network connection 125 comprises all hardware, software, and communications media necessary to enable communication between network nodes 105-120. Unless otherwise indicated in context below, all network nodes use publicly available protocols or messaging services to communicate with each other through network connection 125.

Update Application (UA) 200 comprises Administration Tool (AT) 205 and Service Engine (SE) 210. UA 200 typically is stored in a memory, represented schematically as memory 220 in FIG. 2. The term “memory,” as used herein, includes without limitation any volatile or persistent medium, such as an electrical circuit, magnetic disk, optical disk, or any storage device in which a computer can store data or software for any duration. A single memory may encompass and be distributed across a plurality of media. Thus, FIG. 2 is included merely as a descriptive expedient and does not necessarily reflect any particular physical embodiment of memory 220. As depicted in FIG. 2, though, memory 220 may include additional data and programs. Of particular import to UA 200, memory 220 includes operating system 230, DBMS 240, database 250, and metadata 260, with which UA 200 interacts.

In general, database 250 initially comprises at least one table, such as source table 270. As used herein, the term “source table” refers to any table designed to hold substantive data, as opposed to data that represents the change history of another table. An administrator of database 250 then enrolls source table 270 into UA 200. Although the administrator may manually enroll source table 270, the process preferably is implemented in AT 205 as described below with reference to FIG. 3. Moreover, for the sake of simplicity, the term “administrator” is used below to describe a preferred method of using AT 205, but it should be readily apparent to those skilled in the art that an administrator can delegate or otherwise authorize any other user, particularly a database programmer, to use AT 205 in much the same way.

Referring to FIG. 3, AT 205 starts (302) and displays a graphical user interface (GUI) (not shown) (310) to the administrator. The administrator then indicates an intention to enroll a new source table or modify a previously enrolled source table (312). If a new source table is to be enrolled, AT 205 prompts the administrator to enter parameters necessary for connecting to database 250 (326). Necessary parameters may include without limitation the database host name, database name, user identification, password, or other parameter by which AT 205 can locate and connect to database 250. AT 205 then uses the parameters to connect to database 250 (328). AT 205 then prompts the administrator to enter search criteria (330) to limit the number of tables in the list. Search criteria may include without limitation schema names, table spaces names, and so forth. Alternatively, the administrator may specify all tables as the criteria. Responsive to receiving the criteria, AT 205 uses the search criteria to search database 250 (332). AT 205 then lists all tables that meet the search criteria (334). AT 205 prompts the administrator to select one or more tables, from the displayed list, for which the administrator wants to track changes (336). Responsive to the administrator's selections, AT 205 prompts the administrator to select specific columns that should be tracked (338). If the administrator does not select any specific columns, AT 300 includes all columns by default. AT 205 then prompts the administrator to confirm the selections (342). Assuming for illustrative purposes that the administrator has selected source table 270, upon the administrator's confirmation, AT 205 adds two columns to source table 270 (344). AT 205 adds one column to record the identification of any user that updates a table. AT 205 adds a second column to record the time at which a user updates a record in source table 270. AT 205 then prompts the administrator to specify names for the two columns. If the administrator does not specify names for the columns, then AT 205 provides default values that do not conflict with existing column names of source table 270.

If no user has previously enrolled source table 270, then AT 205 generates a new history table, represented as history table 280 (see FIG. 2) (356). AT 205 then generates metadata 260 (358). Metadata 260 maps the selected columns in source table 270 to columns in history table 280, including the names of the columns that SE 210 will use for recording the identification of any user that updates source table 270 and for recording the time at which an update occurs. AT 205 then saves metadata 260 to persistent storage (360), such as a file or a database table, which SE 210 will access during the execution of the database application. As FIG. 3 indicates, AT 205 continues until the administrator indicates that all tables have been enrolled (362).

If at step 312, the administrator indicates an intention to modify or remove a previously enrolled table, AT 205 reads metadata 260 (314) and lists any previously enrolled tables (316). AT 205 then prompts the administrator to select a previously enrolled table from the list (318). The administrator can then modify metadata 260 associated with the selected table. As used herein, “modify” means to remove or alter the selection or mapping of columns in metadata 260 (320). AT 205 then returns to step 312.

After the administrator configures metadata 260, source table 270, and history table 280, a database programmer no longer has to manually implement code that tracks changes to source table 270. Rather, the database programmer merely has to program a database application to direct database operations to SE 210 instead of DBMS 240. Then, when the database application later executes, SE 210 processes the operation as described below with reference to FIG. 4.

In one preferred embodiment, SE 210 is a middleware application that receives and processes database operations before relaying the operations to a DBMS, such as DBMS 240. Alternatively, or additionally, SE 210 also may be implemented as a wrapper to a DBMS. In either embodiment, though, SE 210 operates substantially as follows. SE 210 starts (402) and receives a request from a database application to execute an operation on source table 270 (410). Generally, the database application sends requests in the form of an SQL statement. SE 210 preferably allows the database application to demarcate database operations as transactions (420). In such an embodiment, the database application only needs to identify the user once per transaction, rather than identifying the user as an SQL parameter in every SQL update statement.

SE 210 then reads metadata 260 (430) to identify columns in history table 280 that map to columns in source table 270 that are affected by the pending database operation. Generally, SE 210 uses metadata 260 and parameters which the database application passes to it, such as table name, column names, and column value types, to generate SQL for updating source table 270 and to generate SQL statements to record the changes to source table 270 in history table 280. The SQL update statement for source table 270 includes the user name provided for the transaction and a current timestamp. The column names for these fields are obtained from metadata 260. SE 210 then propagates the pending changes to source table 270, either directly or through DBMS 240 (440). SE 210 then records the changes to the appropriately mapped columns in history table 280 (450). SE 210 determines whether there is another update (460). If so, SE 400 goes to step 410. If not, SE 400 stops (470).

If at step 430, metadata 260 is not found, then the user name/timestamp combination is not stored and no SQL statements are created for history table 280. In other words, when metadata for a table is not found, the service engine assumes that the table was not enrolled.

A preferred form of the invention has been shown in the drawings and described above, but variations in the preferred form will be apparent to those skilled in the art. The preceding description is for illustration purposes only, and the invention should not be construed as limited to the specific form shown and described. The scope of the invention should be limited only by the language of the following claims. 

1. An apparatus for creating history tables and batching transactions by entity comprising: a computer having a memory; and a program in the memory wherein the program contains instructions to cause the computer to modify a source table by adding a entity column and a timestamp column, generate a history table corresponding to the selected source table, and to generate a plurality of metadata so that when a change is made to the source table by a database application, the history table is automatically updated independent of the database application.
 2. The apparatus of claim 1 wherein the metadata further comprises a plurality of mapping instructions between the source table and the history table.
 3. The apparatus of claim 2 wherein the metadata further comprises a plurality of instructions to specify the table that will be modified and the columns within that table to be updated.
 4. A computer product for creating history tables and batching transactions by entity comprising: a development tool comprising a plurality of instructions to cause a computer to perform the following steps: generating a history table corresponding to the selected source table; generating a plurality of metadata comprising a plurality of mapping instructions between the source table and the history table. a service engine comprising a plurality having a plurality of instructions to cause a computer to perform the following steps: defining a transaction; accessing the metadata; using the metadata, updating the source table and the history table independent of the database application.
 5. The computer program product of claim 4 wherein the development tool further comprises instructions to cause the computer to perform the step of modifying a selected source table by adding an entity column and a timestamp column.
 6. The computer program product of claim 4 wherein the development tool further comprises instructions to cause the computer to perform the step of modifying a selected source table by adding an entity column and a timestamp column.
 7. The computer program product of claim 4 wherein the development tool further comprises instructions to cause the computer to perform the step of connecting to a database instance hosted by the developer using a parameter.
 8. The computer program product of claim 4 wherein the development tool further comprises instructions to cause the computer to perform the step of searching a plurality of tables in a database pursuant to a search criteria; and responsive to finding a match to the criteria, providing a list of tables that meet the criteria.
 9. The computer program product of claim 4 wherein the development tool further comprises instructions to cause the computer to perform the step of receiving update data from an entity application.
 10. The computer program product of claim 4 wherein the development tool further comprises instructions to cause the computer to perform the step of enrolling a selected table so that it may interact with the service engine.
 11. The computer program product of claim 4 wherein the development tool further comprises instructions to cause the computer to perform the step of storing the metadata.
 12. The computer program product of claim 4 wherein the service engine further comprises instructions to cause the computer to perform the step of using a parameter from an application and the metadata to generate statements for updating the source tables and to generate insert statements for the history tables.
 13. The computer program product of claim 4 wherein the development tool further comprises instructions to cause the computer to perform the step of including the user name provided for a transaction and a current timestamp of the action in an update statement.
 14. A method of employing a service engine in a computer connected to a database application and a database comprising: modifying a source table by adding a entity column and a timestamp column; generating a history table corresponding to the source table; and generating a plurality of metadata so that when a change is made to the source table by a database application, the history table is automatically updated independent of the database application.
 15. The method of claim 14 wherein generating a plurality of metadata further comprises: generating a plurality of mapping instructions between the source table and the history table.
 16. The method of claim 14 further comprising: specifying a column within the source table to be updated.
 17. The method of claim 14 further comprising: defining a transaction. 